home *** CD-ROM | disk | FTP | other *** search
/ NeXT Education Software Sampler 1992 Fall / NeXT Education Software Sampler 1992 Fall.iso / READMEFiles / WAIS.README < prev    next >
Text File  |  1992-08-29  |  6KB  |  155 lines
  1.  
  2.         README FILE AND INSTALLATION INSTRUCTIONS
  3.            WAIStation.app for NeXT, Version 1.9
  4.               and WAIS Objective-C Interface
  5.         Created by Paul Burchard <burchard@math.utah.edu>
  6.     Incorporating WAIS software from Thinking Machines Corp.
  7.     
  8. ------------------------------------------------------------------------
  9. README:    WAIS Unix release 8 b3                Fri Sep 13 1991
  10.  Harry Morris                     Thinking Machines Corp
  11.  Brewster Kahle 
  12.  Jonathan Goldman
  13. ------------------------------------------------------------------------
  14.  
  15. WARRANTY DISCLAIMER [with additions from Paul Burchard]
  16.  
  17. This software was created by Thinking Machines Corporation [and Paul Burchard] 
  18. and is distributed free of charge.  It is placed in the public domain and 
  19. permission is granted for anyone to use, duplicate, modify and redistribute it
  20. [so long as this notice is attached].
  21.  
  22. Thinking Machines Corporation [and separately, Paul Burchard, provide] 
  23. absolutely NO WARRANTY OF ANY KIND with respect to this software.  The entire 
  24. risk as to the quality and performance of this software is with the user.
  25.  
  26. IN NO EVENT WILL THINKING MACHINES CORPORATION [OR PAUL BURCHARD]
  27. BE LIABLE TO ANYONE FOR ANY DAMAGES ARISING OUT THE USE OF THIS
  28. SOFTWARE, INCLUDING, WITHOUT LIMITATION, DAMAGES RESULTING FROM LOST DATA OR
  29. LOST PROFITS, OR FOR ANY SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES.
  30.  
  31. ------------------------------------------------------------------------
  32.  
  33. The Wide Area Information Server (WAIS) Project is an experiment,
  34. automating the search and retrieval of many types of electronic information
  35. over wide area networks.  The success of this project depends on the
  36. formation of a large number of "Information Servers": computers that know
  37. how to answer questions over a network.  To help catalyze this market,
  38. Thinking Machines and other organizations are giving away protocol
  39. specifications and source code.  To find out more about the project, please
  40. read doc/wais-concepts.txt.  New releases are announced on the mailing list
  41. wais-interest@think.com, discussion of WAIS issues happens on
  42. wais-discussion@think.com.  To be added to these lists, please send a note
  43. to wais-interest-request@think.com and/or wais-discussion-request@think.com.
  44.  
  45. ------------------------------------------------------------------------
  46.  
  47.  
  48. HOW TO INSTALL WAISTATION.APP:
  49.  
  50. 1. Move the entire WAIS folder into your /LocalLibrary folder.  (If you choose 
  51. to install it elsewhere, see step 3).
  52.  
  53. 2. Symbolically link WAIStation.app into /LocalApps or ~/Apps.
  54. This can be done in the File Viewer by control-dragging it into the
  55. appropriate place.  You can also type
  56.  
  57.     ln -s /LocalLibrary/WAIS/WAIStation.app /LocalApps
  58.  
  59. in a Terminal window (changing the locations in this command as appropriate).
  60.  
  61. 3. If you install the WAIS folder somewhere other than /LocalLibrary (say,
  62. in "My_Folder"), you will need to do two things.  First, re-index the 
  63. pre-indexed documentation by typing the following into a Terminal window:
  64.  
  65.     cd My_Folder/WAIS        # or wherever you installed it
  66.     make doc
  67.     
  68. Second, when you first launch WAIStation.app, open the Preferences panel and 
  69. correct the "System WAIS Folder" entry by entering My_Folder/WAIS (or whatever) 
  70. in place of /LocalLibrary/WAIS.
  71.  
  72. 4. If you want to recompile the whole package (usually not necessary), type the 
  73. following in a Terminal window:
  74.  
  75.     cd /LocalLibrary/WAIS        # or wherever you installed it
  76.     make                # you can ignore the warning messages
  77.     
  78.  
  79.  
  80. WHAT'S IN THIS PACKAGE:
  81.  
  82. This package contains a (sample) toolkit for:
  83.  
  84.   1. creating servers:  waisindex and waisserver.
  85.   2. communicating:     Z39.50 and WAIS protocol software.
  86.   3. clients:           NeXTstep WAIStation.app.
  87.  
  88. This package is distributed as a UNIX tar file.  You should have the
  89. following directories:
  90.  
  91. top = WAIS
  92.  
  93. in top:
  94.  
  95. Makefile    - a top-level Makefile to build the entire system
  96. README        - this file
  97. bin/        - where compiled executables will go (except WAIStation)
  98. doc/        - all documentation
  99. ir/        - the WAIS toolkit, indexer and server code
  100. lib/        - some extra code
  101. sources/    - example sources, including the directory of servers
  102. WAIStation.app    - NeXTstep front end
  103. next-ui/    - WAIStation.app is actually a link to this
  104.  
  105. Unix-style Man pages are in the doc directory. Interfaces for the Apple
  106. Macintosh, the X11 window system, and terminal-only systems are available 
  107. separately.
  108.  
  109.  
  110.  
  111. RANDOM NOTES:
  112.  
  113. From Paul Burchard <burchard@math.utah.edu>:
  114.  
  115. - I've put an Objective-C wrapper around the WAIS protocol.  You can therefore
  116.   design your own programs which plug into WAIS, without having to learn
  117.   any details about this protocol.  See doc/Object-WAIS.rtf for info.
  118.   
  119. - The Objective-C classes in WAIStation.app contain fairly clean code, although
  120.   I haven't had the time to follow all NeXT developer guidelines.
  121.   
  122.  
  123. From the folks at Thinking Machines:
  124.  
  125. - The version of Z39.50 contained herein is for inspection only.  It is based 
  126.   on the obsolete 1988 version.  It will be replaced with an implementation
  127.   of ISO Z39.50 (when it stabilizes).  These protocols are not compatable, 
  128.   although every effort will be made to minimize the conversion effort. 
  129.     
  130. - The best way to learn the use of the Z39.50 library is to study
  131.   the example code in ir.c (for a server) and ui.c and ui (for a client).
  132.   
  133. - The IR engine will undergo further enhancements.
  134.   
  135. - WAIStation is an example Mac program using this protocol.  This is
  136.   provided "as is" as an application that can connect over the phone or
  137.   TCP/IP.  It is available separately, in source code form.  Write for
  138.   details.
  139.  
  140. - Have fun and let us know what you think.  Much of this code needs
  141.   cleanup, we apologize for the present formatting.... The next 
  142.   version will be beautified, clarified, polished, and all.  If you
  143.   have any questions or find any bugs, Don't hesitate to write.
  144.  
  145.       Harry Morris
  146.       Morris@Think.COM
  147.  
  148.     Brewster Kahle
  149.     Brewster@Think.COM
  150.           
  151.     Jonny Goldman
  152.     Jonathan@Think.COM
  153.  
  154.       (617) 876-1111
  155.